home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / python2.4 / optparse.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2005-10-18  |  47KB  |  1,405 lines

  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.4)
  3.  
  4. """optparse - a powerful, extensible, and easy-to-use option parser.
  5.  
  6. By Greg Ward <gward@python.net>
  7.  
  8. Originally distributed as Optik; see http://optik.sourceforge.net/ .
  9.  
  10. If you have problems with this module, please do not file bugs,
  11. patches, or feature requests with Python; instead, use Optik's
  12. SourceForge project page:
  13.   http://sourceforge.net/projects/optik
  14.  
  15. For support, use the optik-users@lists.sourceforge.net mailing list
  16. (http://lists.sourceforge.net/lists/listinfo/optik-users).
  17. """
  18. __version__ = '1.5a2'
  19. __all__ = [
  20.     'Option',
  21.     'SUPPRESS_HELP',
  22.     'SUPPRESS_USAGE',
  23.     'Values',
  24.     'OptionContainer',
  25.     'OptionGroup',
  26.     'OptionParser',
  27.     'HelpFormatter',
  28.     'IndentedHelpFormatter',
  29.     'TitledHelpFormatter',
  30.     'OptParseError',
  31.     'OptionError',
  32.     'OptionConflictError',
  33.     'OptionValueError',
  34.     'BadOptionError']
  35. __copyright__ = '\nCopyright (c) 2001-2004 Gregory P. Ward.  All rights reserved.\nCopyright (c) 2002-2004 Python Software Foundation.  All rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n  * Redistributions of source code must retain the above copyright\n    notice, this list of conditions and the following disclaimer.\n\n  * Redistributions in binary form must reproduce the above copyright\n    notice, this list of conditions and the following disclaimer in the\n    documentation and/or other materials provided with the distribution.\n\n  * Neither the name of the author nor the names of its\n    contributors may be used to endorse or promote products derived from\n    this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS\nIS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED\nTO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n'
  36. import sys
  37. import os
  38. import types
  39. import textwrap
  40. from gettext import gettext as _
  41.  
  42. def _repr(self):
  43.     return '<%s at 0x%x: %s>' % (self.__class__.__name__, id(self), self)
  44.  
  45.  
  46. class OptParseError(Exception):
  47.     
  48.     def __init__(self, msg):
  49.         self.msg = msg
  50.  
  51.     
  52.     def __str__(self):
  53.         return self.msg
  54.  
  55.  
  56.  
  57. class OptionError(OptParseError):
  58.     '''
  59.     Raised if an Option instance is created with invalid or
  60.     inconsistent arguments.
  61.     '''
  62.     
  63.     def __init__(self, msg, option):
  64.         self.msg = msg
  65.         self.option_id = str(option)
  66.  
  67.     
  68.     def __str__(self):
  69.         if self.option_id:
  70.             return 'option %s: %s' % (self.option_id, self.msg)
  71.         else:
  72.             return self.msg
  73.  
  74.  
  75.  
  76. class OptionConflictError(OptionError):
  77.     '''
  78.     Raised if conflicting options are added to an OptionParser.
  79.     '''
  80.     pass
  81.  
  82.  
  83. class OptionValueError(OptParseError):
  84.     '''
  85.     Raised if an invalid option value is encountered on the command
  86.     line.
  87.     '''
  88.     pass
  89.  
  90.  
  91. class BadOptionError(OptParseError):
  92.     '''
  93.     Raised if an invalid or ambiguous option is seen on the command-line.
  94.     '''
  95.     pass
  96.  
  97.  
  98. class HelpFormatter:
  99.     '''
  100.     Abstract base class for formatting option help.  OptionParser
  101.     instances should use one of the HelpFormatter subclasses for
  102.     formatting help; by default IndentedHelpFormatter is used.
  103.  
  104.     Instance attributes:
  105.       parser : OptionParser
  106.         the controlling OptionParser instance
  107.       indent_increment : int
  108.         the number of columns to indent per nesting level
  109.       max_help_position : int
  110.         the maximum starting column for option help text
  111.       help_position : int
  112.         the calculated starting column for option help text;
  113.         initially the same as the maximum
  114.       width : int
  115.         total number of columns for output (pass None to constructor for
  116.         this value to be taken from the $COLUMNS environment variable)
  117.       level : int
  118.         current indentation level
  119.       current_indent : int
  120.         current indentation level (in columns)
  121.       help_width : int
  122.         number of columns available for option help text (calculated)
  123.       default_tag : str
  124.         text to replace with each option\'s default value, "%default"
  125.         by default.  Set to false value to disable default value expansion.
  126.       option_strings : { Option : str }
  127.         maps Option instances to the snippet of help text explaining
  128.         the syntax of that option, e.g. "-h, --help" or
  129.         "-fFILE, --file=FILE"
  130.       _short_opt_fmt : str
  131.         format string controlling how short options with values are
  132.         printed in help text.  Must be either "%s%s" ("-fFILE") or
  133.         "%s %s" ("-f FILE"), because those are the two syntaxes that
  134.         Optik supports.
  135.       _long_opt_fmt : str
  136.         similar but for long options; must be either "%s %s" ("--file FILE")
  137.         or "%s=%s" ("--file=FILE").
  138.     '''
  139.     NO_DEFAULT_VALUE = 'none'
  140.     
  141.     def __init__(self, indent_increment, max_help_position, width, short_first):
  142.         self.parser = None
  143.         self.indent_increment = indent_increment
  144.         self.help_position = self.max_help_position = max_help_position
  145.         if width is None:
  146.             
  147.             try:
  148.                 width = int(os.environ['COLUMNS'])
  149.             except (KeyError, ValueError):
  150.                 width = 80
  151.  
  152.             width -= 2
  153.         
  154.         self.width = width
  155.         self.current_indent = 0
  156.         self.level = 0
  157.         self.help_width = None
  158.         self.short_first = short_first
  159.         self.default_tag = '%default'
  160.         self.option_strings = { }
  161.         self._short_opt_fmt = '%s %s'
  162.         self._long_opt_fmt = '%s=%s'
  163.  
  164.     
  165.     def set_parser(self, parser):
  166.         self.parser = parser
  167.  
  168.     
  169.     def set_short_opt_delimiter(self, delim):
  170.         if delim not in ('', ' '):
  171.             raise ValueError('invalid metavar delimiter for short options: %r' % delim)
  172.         
  173.         self._short_opt_fmt = '%s' + delim + '%s'
  174.  
  175.     
  176.     def set_long_opt_delimiter(self, delim):
  177.         if delim not in ('=', ' '):
  178.             raise ValueError('invalid metavar delimiter for long options: %r' % delim)
  179.         
  180.         self._long_opt_fmt = '%s' + delim + '%s'
  181.  
  182.     
  183.     def indent(self):
  184.         self.current_indent += self.indent_increment
  185.         self.level += 1
  186.  
  187.     
  188.     def dedent(self):
  189.         self.current_indent -= self.indent_increment
  190.         if not self.current_indent >= 0:
  191.             raise AssertionError, 'Indent decreased below 0.'
  192.         self
  193.         self.level -= 1
  194.  
  195.     
  196.     def format_usage(self, usage):
  197.         raise NotImplementedError, 'subclasses must implement'
  198.  
  199.     
  200.     def format_heading(self, heading):
  201.         raise NotImplementedError, 'subclasses must implement'
  202.  
  203.     
  204.     def format_description(self, description):
  205.         if not description:
  206.             return ''
  207.         
  208.         desc_width = self.width - self.current_indent
  209.         indent = ' ' * self.current_indent
  210.         return textwrap.fill(description, desc_width, initial_indent = indent, subsequent_indent = indent) + '\n'
  211.  
  212.     
  213.     def expand_default(self, option):
  214.         if self.parser is None or not (self.default_tag):
  215.             return option.help
  216.         
  217.         default_value = self.parser.defaults.get(option.dest)
  218.         if default_value is NO_DEFAULT or default_value is None:
  219.             default_value = self.NO_DEFAULT_VALUE
  220.         
  221.         return option.help.replace(self.default_tag, str(default_value))
  222.  
  223.     
  224.     def format_option(self, option):
  225.         result = []
  226.         opts = self.option_strings[option]
  227.         opt_width = self.help_position - self.current_indent - 2
  228.         if len(opts) > opt_width:
  229.             opts = '%*s%s\n' % (self.current_indent, '', opts)
  230.             indent_first = self.help_position
  231.         else:
  232.             opts = '%*s%-*s  ' % (self.current_indent, '', opt_width, opts)
  233.             indent_first = 0
  234.         result.append(opts)
  235.         if option.help:
  236.             help_text = self.expand_default(option)
  237.             help_lines = textwrap.wrap(help_text, self.help_width)
  238.             result.append('%*s%s\n' % (indent_first, '', help_lines[0]))
  239.             []([ '%*s%s\n' % (self.help_position, '', line) for line in help_lines[1:] ])
  240.         elif opts[-1] != '\n':
  241.             result.append('\n')
  242.         
  243.         return ''.join(result)
  244.  
  245.     
  246.     def store_option_strings(self, parser):
  247.         self.indent()
  248.         max_len = 0
  249.         for opt in parser.option_list:
  250.             strings = self.format_option_strings(opt)
  251.             self.option_strings[opt] = strings
  252.             max_len = max(max_len, len(strings) + self.current_indent)
  253.         
  254.         self.indent()
  255.         for group in parser.option_groups:
  256.             for opt in group.option_list:
  257.                 strings = self.format_option_strings(opt)
  258.                 self.option_strings[opt] = strings
  259.                 max_len = max(max_len, len(strings) + self.current_indent)
  260.             
  261.         
  262.         self.dedent()
  263.         self.dedent()
  264.         self.help_position = min(max_len + 2, self.max_help_position)
  265.         self.help_width = self.width - self.help_position
  266.  
  267.     
  268.     def format_option_strings(self, option):
  269.         '''Return a comma-separated list of option strings & metavariables.'''
  270.         return ', '.join(opts)
  271.  
  272.  
  273.  
  274. class IndentedHelpFormatter(HelpFormatter):
  275.     '''Format help with indented section bodies.
  276.     '''
  277.     
  278.     def __init__(self, indent_increment = 2, max_help_position = 24, width = None, short_first = 1):
  279.         HelpFormatter.__init__(self, indent_increment, max_help_position, width, short_first)
  280.  
  281.     
  282.     def format_usage(self, usage):
  283.         return _('usage: %s\n') % usage
  284.  
  285.     
  286.     def format_heading(self, heading):
  287.         return '%*s%s:\n' % (self.current_indent, '', heading)
  288.  
  289.  
  290.  
  291. class TitledHelpFormatter(HelpFormatter):
  292.     '''Format help with underlined section headers.
  293.     '''
  294.     
  295.     def __init__(self, indent_increment = 0, max_help_position = 24, width = None, short_first = 0):
  296.         HelpFormatter.__init__(self, indent_increment, max_help_position, width, short_first)
  297.  
  298.     
  299.     def format_usage(self, usage):
  300.         return '%s  %s\n' % (self.format_heading(_('Usage')), usage)
  301.  
  302.     
  303.     def format_heading(self, heading):
  304.         return '%s\n%s\n' % (heading, '=-'[self.level] * len(heading))
  305.  
  306.  
  307. _builtin_cvt = {
  308.     'int': (int, _('integer')),
  309.     'long': (long, _('long integer')),
  310.     'float': (float, _('floating-point')),
  311.     'complex': (complex, _('complex')) }
  312.  
  313. def check_builtin(option, opt, value):
  314.     (cvt, what) = _builtin_cvt[option.type]
  315.     
  316.     try:
  317.         return cvt(value)
  318.     except ValueError:
  319.         raise OptionValueError(_('option %s: invalid %s value: %r') % (opt, what, value))
  320.  
  321.  
  322.  
  323. def check_choice(option, opt, value):
  324.     if value in option.choices:
  325.         return value
  326.     else:
  327.         choices = ', '.join(map(repr, option.choices))
  328.         raise OptionValueError(_('option %s: invalid choice: %r (choose from %s)') % (opt, value, choices))
  329.  
  330. NO_DEFAULT = ('NO', 'DEFAULT')
  331.  
  332. class Option:
  333.     '''
  334.     Instance attributes:
  335.       _short_opts : [string]
  336.       _long_opts : [string]
  337.  
  338.       action : string
  339.       type : string
  340.       dest : string
  341.       default : any
  342.       nargs : int
  343.       const : any
  344.       choices : [string]
  345.       callback : function
  346.       callback_args : (any*)
  347.       callback_kwargs : { string : any }
  348.       help : string
  349.       metavar : string
  350.     '''
  351.     ATTRS = [
  352.         'action',
  353.         'type',
  354.         'dest',
  355.         'default',
  356.         'nargs',
  357.         'const',
  358.         'choices',
  359.         'callback',
  360.         'callback_args',
  361.         'callback_kwargs',
  362.         'help',
  363.         'metavar']
  364.     ACTIONS = ('store', 'store_const', 'store_true', 'store_false', 'append', 'count', 'callback', 'help', 'version')
  365.     STORE_ACTIONS = ('store', 'store_const', 'store_true', 'store_false', 'append', 'count')
  366.     TYPED_ACTIONS = ('store', 'append', 'callback')
  367.     ALWAYS_TYPED_ACTIONS = ('store', 'append')
  368.     TYPES = ('string', 'int', 'long', 'float', 'complex', 'choice')
  369.     TYPE_CHECKER = {
  370.         'int': check_builtin,
  371.         'long': check_builtin,
  372.         'float': check_builtin,
  373.         'complex': check_builtin,
  374.         'choice': check_choice }
  375.     CHECK_METHODS = None
  376.     
  377.     def __init__(self, *opts, **attrs):
  378.         self._short_opts = []
  379.         self._long_opts = []
  380.         opts = self._check_opt_strings(opts)
  381.         self._set_opt_strings(opts)
  382.         self._set_attrs(attrs)
  383.         for checker in self.CHECK_METHODS:
  384.             checker(self)
  385.         
  386.  
  387.     
  388.     def _check_opt_strings(self, opts):
  389.         opts = filter(None, opts)
  390.         if not opts:
  391.             raise TypeError('at least one option string must be supplied')
  392.         
  393.         return opts
  394.  
  395.     
  396.     def _set_opt_strings(self, opts):
  397.         for opt in opts:
  398.             if len(opt) < 2:
  399.                 raise OptionError('invalid option string %r: must be at least two characters long' % opt, self)
  400.                 continue
  401.             if len(opt) == 2:
  402.                 if not opt[0] == '-' and opt[1] != '-':
  403.                     raise OptionError('invalid short option string %r: must be of the form -x, (x any non-dash char)' % opt, self)
  404.                 
  405.                 self._short_opts.append(opt)
  406.                 continue
  407.             if not opt[0:2] == '--' and opt[2] != '-':
  408.                 raise OptionError('invalid long option string %r: must start with --, followed by non-dash' % opt, self)
  409.             
  410.             self._long_opts.append(opt)
  411.         
  412.  
  413.     
  414.     def _set_attrs(self, attrs):
  415.         for attr in self.ATTRS:
  416.             if attrs.has_key(attr):
  417.                 setattr(self, attr, attrs[attr])
  418.                 del attrs[attr]
  419.                 continue
  420.             if attr == 'default':
  421.                 setattr(self, attr, NO_DEFAULT)
  422.                 continue
  423.             setattr(self, attr, None)
  424.         
  425.         if attrs:
  426.             raise OptionError('invalid keyword arguments: %s' % ', '.join(attrs.keys()), self)
  427.         
  428.  
  429.     
  430.     def _check_action(self):
  431.         if self.action is None:
  432.             self.action = 'store'
  433.         elif self.action not in self.ACTIONS:
  434.             raise OptionError('invalid action: %r' % self.action, self)
  435.         
  436.  
  437.     
  438.     def _check_type(self):
  439.         if self.type is None:
  440.             if self.action in self.ALWAYS_TYPED_ACTIONS:
  441.                 if self.choices is not None:
  442.                     self.type = 'choice'
  443.                 else:
  444.                     self.type = 'string'
  445.             
  446.         elif type(self.type) is type:
  447.             self.type = self.type.__name__
  448.         
  449.         if self.type == 'str':
  450.             self.type = 'string'
  451.         
  452.         if self.type not in self.TYPES:
  453.             raise OptionError('invalid option type: %r' % self.type, self)
  454.         
  455.         if self.action not in self.TYPED_ACTIONS:
  456.             raise OptionError('must not supply a type for action %r' % self.action, self)
  457.         
  458.  
  459.     
  460.     def _check_choice(self):
  461.         if self.type == 'choice':
  462.             if self.choices is None:
  463.                 raise OptionError("must supply a list of choices for type 'choice'", self)
  464.             elif type(self.choices) not in (types.TupleType, types.ListType):
  465.                 raise OptionError("choices must be a list of strings ('%s' supplied)" % str(type(self.choices)).split("'")[1], self)
  466.             
  467.         elif self.choices is not None:
  468.             raise OptionError('must not supply choices for type %r' % self.type, self)
  469.         
  470.  
  471.     
  472.     def _check_dest(self):
  473.         if not self.action in self.STORE_ACTIONS:
  474.             pass
  475.         takes_value = self.type is not None
  476.         if self.dest is None and takes_value:
  477.             if self._long_opts:
  478.                 self.dest = self._long_opts[0][2:].replace('-', '_')
  479.             else:
  480.                 self.dest = self._short_opts[0][1]
  481.         
  482.  
  483.     
  484.     def _check_const(self):
  485.         if self.action != 'store_const' and self.const is not None:
  486.             raise OptionError("'const' must not be supplied for action %r" % self.action, self)
  487.         
  488.  
  489.     
  490.     def _check_nargs(self):
  491.         if self.action in self.TYPED_ACTIONS:
  492.             if self.nargs is None:
  493.                 self.nargs = 1
  494.             
  495.         elif self.nargs is not None:
  496.             raise OptionError("'nargs' must not be supplied for action %r" % self.action, self)
  497.         
  498.  
  499.     
  500.     def _check_callback(self):
  501.         if self.action == 'callback':
  502.             if not callable(self.callback):
  503.                 raise OptionError('callback not callable: %r' % self.callback, self)
  504.             
  505.             if self.callback_args is not None and type(self.callback_args) is not types.TupleType:
  506.                 raise OptionError('callback_args, if supplied, must be a tuple: not %r' % self.callback_args, self)
  507.             
  508.             if self.callback_kwargs is not None and type(self.callback_kwargs) is not types.DictType:
  509.                 raise OptionError('callback_kwargs, if supplied, must be a dict: not %r' % self.callback_kwargs, self)
  510.             
  511.         elif self.callback is not None:
  512.             raise OptionError('callback supplied (%r) for non-callback option' % self.callback, self)
  513.         
  514.         if self.callback_args is not None:
  515.             raise OptionError('callback_args supplied for non-callback option', self)
  516.         
  517.         if self.callback_kwargs is not None:
  518.             raise OptionError('callback_kwargs supplied for non-callback option', self)
  519.         
  520.  
  521.     CHECK_METHODS = [
  522.         _check_action,
  523.         _check_type,
  524.         _check_choice,
  525.         _check_dest,
  526.         _check_const,
  527.         _check_nargs,
  528.         _check_callback]
  529.     
  530.     def __str__(self):
  531.         return '/'.join(self._short_opts + self._long_opts)
  532.  
  533.     __repr__ = _repr
  534.     
  535.     def takes_value(self):
  536.         return self.type is not None
  537.  
  538.     
  539.     def get_opt_string(self):
  540.         if self._long_opts:
  541.             return self._long_opts[0]
  542.         else:
  543.             return self._short_opts[0]
  544.  
  545.     
  546.     def check_value(self, opt, value):
  547.         checker = self.TYPE_CHECKER.get(self.type)
  548.         if checker is None:
  549.             return value
  550.         else:
  551.             return checker(self, opt, value)
  552.  
  553.     
  554.     def convert_value(self, opt, value):
  555.         pass
  556.  
  557.     
  558.     def process(self, opt, value, values, parser):
  559.         value = self.convert_value(opt, value)
  560.         return self.take_action(self.action, self.dest, opt, value, values, parser)
  561.  
  562.     
  563.     def take_action(self, action, dest, opt, value, values, parser):
  564.         if action == 'store':
  565.             setattr(values, dest, value)
  566.         elif action == 'store_const':
  567.             setattr(values, dest, self.const)
  568.         elif action == 'store_true':
  569.             setattr(values, dest, True)
  570.         elif action == 'store_false':
  571.             setattr(values, dest, False)
  572.         elif action == 'append':
  573.             values.ensure_value(dest, []).append(value)
  574.         elif action == 'count':
  575.             setattr(values, dest, values.ensure_value(dest, 0) + 1)
  576.         elif action == 'callback':
  577.             if not self.callback_args:
  578.                 pass
  579.             args = ()
  580.             if not self.callback_kwargs:
  581.                 pass
  582.             kwargs = { }
  583.             self.callback(self, opt, value, parser, *args, **kwargs)
  584.         elif action == 'help':
  585.             parser.print_help()
  586.             parser.exit()
  587.         elif action == 'version':
  588.             parser.print_version()
  589.             parser.exit()
  590.         else:
  591.             raise RuntimeError, 'unknown action %r' % self.action
  592.         return 1
  593.  
  594.  
  595. SUPPRESS_HELP = 'SUPPRESS' + 'HELP'
  596. SUPPRESS_USAGE = 'SUPPRESS' + 'USAGE'
  597.  
  598. try:
  599.     (True, False)
  600. except NameError:
  601.     (True, False) = (1, 0)
  602.  
  603.  
  604. try:
  605.     basestring
  606. except NameError:
  607.     basestring = (str, unicode)
  608.  
  609.  
  610. class Values:
  611.     
  612.     def __init__(self, defaults = None):
  613.         if defaults:
  614.             for attr, val in defaults.items():
  615.                 setattr(self, attr, val)
  616.             
  617.         
  618.  
  619.     
  620.     def __str__(self):
  621.         return str(self.__dict__)
  622.  
  623.     __repr__ = _repr
  624.     
  625.     def __eq__(self, other):
  626.         if isinstance(other, Values):
  627.             return self.__dict__ == other.__dict__
  628.         elif isinstance(other, dict):
  629.             return self.__dict__ == other
  630.         else:
  631.             return False
  632.  
  633.     
  634.     def __ne__(self, other):
  635.         return not (self == other)
  636.  
  637.     
  638.     def _update_careful(self, dict):
  639.         '''
  640.         Update the option values from an arbitrary dictionary, but only
  641.         use keys from dict that already have a corresponding attribute
  642.         in self.  Any keys in dict without a corresponding attribute
  643.         are silently ignored.
  644.         '''
  645.         for attr in dir(self):
  646.             if dict.has_key(attr):
  647.                 dval = dict[attr]
  648.                 if dval is not None:
  649.                     setattr(self, attr, dval)
  650.                 
  651.             dval is not None
  652.         
  653.  
  654.     
  655.     def _update_loose(self, dict):
  656.         '''
  657.         Update the option values from an arbitrary dictionary,
  658.         using all keys from the dictionary regardless of whether
  659.         they have a corresponding attribute in self or not.
  660.         '''
  661.         self.__dict__.update(dict)
  662.  
  663.     
  664.     def _update(self, dict, mode):
  665.         if mode == 'careful':
  666.             self._update_careful(dict)
  667.         elif mode == 'loose':
  668.             self._update_loose(dict)
  669.         else:
  670.             raise ValueError, 'invalid update mode: %r' % mode
  671.  
  672.     
  673.     def read_module(self, modname, mode = 'careful'):
  674.         __import__(modname)
  675.         mod = sys.modules[modname]
  676.         self._update(vars(mod), mode)
  677.  
  678.     
  679.     def read_file(self, filename, mode = 'careful'):
  680.         vars = { }
  681.         execfile(filename, vars)
  682.         self._update(vars, mode)
  683.  
  684.     
  685.     def ensure_value(self, attr, value):
  686.         if not hasattr(self, attr) or getattr(self, attr) is None:
  687.             setattr(self, attr, value)
  688.         
  689.         return getattr(self, attr)
  690.  
  691.  
  692.  
  693. class OptionContainer:
  694.     '''
  695.     Abstract base class.
  696.  
  697.     Class attributes:
  698.       standard_option_list : [Option]
  699.         list of standard options that will be accepted by all instances
  700.         of this parser class (intended to be overridden by subclasses).
  701.  
  702.     Instance attributes:
  703.       option_list : [Option]
  704.         the list of Option objects contained by this OptionContainer
  705.       _short_opt : { string : Option }
  706.         dictionary mapping short option strings, eg. "-f" or "-X",
  707.         to the Option instances that implement them.  If an Option
  708.         has multiple short option strings, it will appears in this
  709.         dictionary multiple times. [1]
  710.       _long_opt : { string : Option }
  711.         dictionary mapping long option strings, eg. "--file" or
  712.         "--exclude", to the Option instances that implement them.
  713.         Again, a given Option can occur multiple times in this
  714.         dictionary. [1]
  715.       defaults : { string : any }
  716.         dictionary mapping option destination names to default
  717.         values for each destination [1]
  718.  
  719.     [1] These mappings are common to (shared by) all components of the
  720.         controlling OptionParser, where they are initially created.
  721.  
  722.     '''
  723.     
  724.     def __init__(self, option_class, conflict_handler, description):
  725.         self._create_option_list()
  726.         self.option_class = option_class
  727.         self.set_conflict_handler(conflict_handler)
  728.         self.set_description(description)
  729.  
  730.     
  731.     def _create_option_mappings(self):
  732.         self._short_opt = { }
  733.         self._long_opt = { }
  734.         self.defaults = { }
  735.  
  736.     
  737.     def _share_option_mappings(self, parser):
  738.         self._short_opt = parser._short_opt
  739.         self._long_opt = parser._long_opt
  740.         self.defaults = parser.defaults
  741.  
  742.     
  743.     def set_conflict_handler(self, handler):
  744.         if handler not in ('error', 'resolve'):
  745.             raise ValueError, 'invalid conflict_resolution value %r' % handler
  746.         
  747.         self.conflict_handler = handler
  748.  
  749.     
  750.     def set_description(self, description):
  751.         self.description = description
  752.  
  753.     
  754.     def get_description(self):
  755.         return self.description
  756.  
  757.     
  758.     def _check_conflict(self, option):
  759.         conflict_opts = []
  760.         for opt in option._short_opts:
  761.             if self._short_opt.has_key(opt):
  762.                 conflict_opts.append((opt, self._short_opt[opt]))
  763.                 continue
  764.         
  765.         for opt in option._long_opts:
  766.             if self._long_opt.has_key(opt):
  767.                 conflict_opts.append((opt, self._long_opt[opt]))
  768.                 continue
  769.         
  770.         if conflict_opts:
  771.             handler = self.conflict_handler
  772.             if handler == 'error':
  773.                 raise ', '.join([] % []([ co[0] for co in conflict_opts ]), option)
  774.             elif handler == 'resolve':
  775.                 for opt, c_option in conflict_opts:
  776.                     if opt.startswith('--'):
  777.                         c_option._long_opts.remove(opt)
  778.                         del self._long_opt[opt]
  779.                     else:
  780.                         c_option._short_opts.remove(opt)
  781.                         del self._short_opt[opt]
  782.                     if not c_option._short_opts or c_option._long_opts:
  783.                         c_option.container.option_list.remove(c_option)
  784.                         continue
  785.                 
  786.             
  787.         
  788.  
  789.     
  790.     def add_option(self, *args, **kwargs):
  791.         '''add_option(Option)
  792.            add_option(opt_str, ..., kwarg=val, ...)
  793.         '''
  794.         if type(args[0]) is types.StringType:
  795.             option = self.option_class(*args, **kwargs)
  796.         elif len(args) == 1 and not kwargs:
  797.             option = args[0]
  798.             if not isinstance(option, Option):
  799.                 raise TypeError, 'not an Option instance: %r' % option
  800.             
  801.         else:
  802.             raise TypeError, 'invalid arguments'
  803.         self._check_conflict(option)
  804.         self.option_list.append(option)
  805.         option.container = self
  806.         for opt in option._short_opts:
  807.             self._short_opt[opt] = option
  808.         
  809.         for opt in option._long_opts:
  810.             self._long_opt[opt] = option
  811.         
  812.         if option.dest is not None:
  813.             if option.default is not NO_DEFAULT:
  814.                 self.defaults[option.dest] = option.default
  815.             elif not self.defaults.has_key(option.dest):
  816.                 self.defaults[option.dest] = None
  817.             
  818.         
  819.         return option
  820.  
  821.     
  822.     def add_options(self, option_list):
  823.         for option in option_list:
  824.             self.add_option(option)
  825.         
  826.  
  827.     
  828.     def get_option(self, opt_str):
  829.         if not self._short_opt.get(opt_str):
  830.             pass
  831.         return self._long_opt.get(opt_str)
  832.  
  833.     
  834.     def has_option(self, opt_str):
  835.         if not self._short_opt.has_key(opt_str):
  836.             pass
  837.         return self._long_opt.has_key(opt_str)
  838.  
  839.     
  840.     def remove_option(self, opt_str):
  841.         option = self._short_opt.get(opt_str)
  842.         if option is None:
  843.             option = self._long_opt.get(opt_str)
  844.         
  845.         if option is None:
  846.             raise ValueError('no such option %r' % opt_str)
  847.         
  848.         for opt in option._short_opts:
  849.             del self._short_opt[opt]
  850.         
  851.         for opt in option._long_opts:
  852.             del self._long_opt[opt]
  853.         
  854.         option.container.option_list.remove(option)
  855.  
  856.     
  857.     def format_option_help(self, formatter):
  858.         if not self.option_list:
  859.             return ''
  860.         
  861.         result = []
  862.         for option in self.option_list:
  863.             if option.help is not SUPPRESS_HELP:
  864.                 result.append(formatter.format_option(option))
  865.                 continue
  866.         
  867.         return ''.join(result)
  868.  
  869.     
  870.     def format_description(self, formatter):
  871.         return formatter.format_description(self.get_description())
  872.  
  873.     
  874.     def format_help(self, formatter):
  875.         result = []
  876.         if self.description:
  877.             result.append(self.format_description(formatter))
  878.         
  879.         if self.option_list:
  880.             result.append(self.format_option_help(formatter))
  881.         
  882.         return '\n'.join(result)
  883.  
  884.  
  885.  
  886. class OptionGroup(OptionContainer):
  887.     
  888.     def __init__(self, parser, title, description = None):
  889.         self.parser = parser
  890.         OptionContainer.__init__(self, parser.option_class, parser.conflict_handler, description)
  891.         self.title = title
  892.  
  893.     
  894.     def _create_option_list(self):
  895.         self.option_list = []
  896.         self._share_option_mappings(self.parser)
  897.  
  898.     
  899.     def set_title(self, title):
  900.         self.title = title
  901.  
  902.     
  903.     def format_help(self, formatter):
  904.         result = formatter.format_heading(self.title)
  905.         formatter.indent()
  906.         result += OptionContainer.format_help(self, formatter)
  907.         formatter.dedent()
  908.         return result
  909.  
  910.  
  911.  
  912. class OptionParser(OptionContainer):
  913.     '''
  914.     Class attributes:
  915.       standard_option_list : [Option]
  916.         list of standard options that will be accepted by all instances
  917.         of this parser class (intended to be overridden by subclasses).
  918.  
  919.     Instance attributes:
  920.       usage : string
  921.         a usage string for your program.  Before it is displayed
  922.         to the user, "%prog" will be expanded to the name of
  923.         your program (self.prog or os.path.basename(sys.argv[0])).
  924.       prog : string
  925.         the name of the current program (to override
  926.         os.path.basename(sys.argv[0])).
  927.  
  928.       option_groups : [OptionGroup]
  929.         list of option groups in this parser (option groups are
  930.         irrelevant for parsing the command-line, but very useful
  931.         for generating help)
  932.  
  933.       allow_interspersed_args : bool = true
  934.         if true, positional arguments may be interspersed with options.
  935.         Assuming -a and -b each take a single argument, the command-line
  936.           -ablah foo bar -bboo baz
  937.         will be interpreted the same as
  938.           -ablah -bboo -- foo bar baz
  939.         If this flag were false, that command line would be interpreted as
  940.           -ablah -- foo bar -bboo baz
  941.         -- ie. we stop processing options as soon as we see the first
  942.         non-option argument.  (This is the tradition followed by
  943.         Python\'s getopt module, Perl\'s Getopt::Std, and other argument-
  944.         parsing libraries, but it is generally annoying to users.)
  945.  
  946.       process_default_values : bool = true
  947.         if true, option default values are processed similarly to option
  948.         values from the command line: that is, they are passed to the
  949.         type-checking function for the option\'s type (as long as the
  950.         default value is a string).  (This really only matters if you
  951.         have defined custom types; see SF bug #955889.)  Set it to false
  952.         to restore the behaviour of Optik 1.4.1 and earlier.
  953.  
  954.       rargs : [string]
  955.         the argument list currently being parsed.  Only set when
  956.         parse_args() is active, and continually trimmed down as
  957.         we consume arguments.  Mainly there for the benefit of
  958.         callback options.
  959.       largs : [string]
  960.         the list of leftover arguments that we have skipped while
  961.         parsing options.  If allow_interspersed_args is false, this
  962.         list is always empty.
  963.       values : Values
  964.         the set of option values currently being accumulated.  Only
  965.         set when parse_args() is active.  Also mainly for callbacks.
  966.  
  967.     Because of the \'rargs\', \'largs\', and \'values\' attributes,
  968.     OptionParser is not thread-safe.  If, for some perverse reason, you
  969.     need to parse command-line arguments simultaneously in different
  970.     threads, use different OptionParser instances.
  971.  
  972.     '''
  973.     standard_option_list = []
  974.     
  975.     def __init__(self, usage = None, option_list = None, option_class = Option, version = None, conflict_handler = 'error', description = None, formatter = None, add_help_option = True, prog = None):
  976.         OptionContainer.__init__(self, option_class, conflict_handler, description)
  977.         self.set_usage(usage)
  978.         self.prog = prog
  979.         self.version = version
  980.         self.allow_interspersed_args = True
  981.         self.process_default_values = True
  982.         if formatter is None:
  983.             formatter = IndentedHelpFormatter()
  984.         
  985.         self.formatter = formatter
  986.         self.formatter.set_parser(self)
  987.         self._populate_option_list(option_list, add_help = add_help_option)
  988.         self._init_parsing_state()
  989.  
  990.     
  991.     def _create_option_list(self):
  992.         self.option_list = []
  993.         self.option_groups = []
  994.         self._create_option_mappings()
  995.  
  996.     
  997.     def _add_help_option(self):
  998.         self.add_option('-h', '--help', action = 'help', help = _('show this help message and exit'))
  999.  
  1000.     
  1001.     def _add_version_option(self):
  1002.         self.add_option('--version', action = 'version', help = _("show program's version number and exit"))
  1003.  
  1004.     
  1005.     def _populate_option_list(self, option_list, add_help = True):
  1006.         if self.standard_option_list:
  1007.             self.add_options(self.standard_option_list)
  1008.         
  1009.         if option_list:
  1010.             self.add_options(option_list)
  1011.         
  1012.         if self.version:
  1013.             self._add_version_option()
  1014.         
  1015.         if add_help:
  1016.             self._add_help_option()
  1017.         
  1018.  
  1019.     
  1020.     def _init_parsing_state(self):
  1021.         self.rargs = None
  1022.         self.largs = None
  1023.         self.values = None
  1024.  
  1025.     
  1026.     def set_usage(self, usage):
  1027.         if usage is None:
  1028.             self.usage = _('%prog [options]')
  1029.         elif usage is SUPPRESS_USAGE:
  1030.             self.usage = None
  1031.         elif usage.startswith('usage:' + ' '):
  1032.             self.usage = usage[7:]
  1033.         else:
  1034.             self.usage = usage
  1035.  
  1036.     
  1037.     def enable_interspersed_args(self):
  1038.         self.allow_interspersed_args = True
  1039.  
  1040.     
  1041.     def disable_interspersed_args(self):
  1042.         self.allow_interspersed_args = False
  1043.  
  1044.     
  1045.     def set_process_default_values(self, process):
  1046.         self.process_default_values = process
  1047.  
  1048.     
  1049.     def set_default(self, dest, value):
  1050.         self.defaults[dest] = value
  1051.  
  1052.     
  1053.     def set_defaults(self, **kwargs):
  1054.         self.defaults.update(kwargs)
  1055.  
  1056.     
  1057.     def _get_all_options(self):
  1058.         options = self.option_list[:]
  1059.         for group in self.option_groups:
  1060.             options.extend(group.option_list)
  1061.         
  1062.         return options
  1063.  
  1064.     
  1065.     def get_default_values(self):
  1066.         if not self.process_default_values:
  1067.             return Values(self.defaults)
  1068.         
  1069.         defaults = self.defaults.copy()
  1070.         for option in self._get_all_options():
  1071.             default = defaults.get(option.dest)
  1072.             if isinstance(default, basestring):
  1073.                 opt_str = option.get_opt_string()
  1074.                 defaults[option.dest] = option.check_value(opt_str, default)
  1075.                 continue
  1076.         
  1077.         return Values(defaults)
  1078.  
  1079.     
  1080.     def add_option_group(self, *args, **kwargs):
  1081.         if type(args[0]) is types.StringType:
  1082.             group = OptionGroup(self, *args, **kwargs)
  1083.         elif len(args) == 1 and not kwargs:
  1084.             group = args[0]
  1085.             if not isinstance(group, OptionGroup):
  1086.                 raise TypeError, 'not an OptionGroup instance: %r' % group
  1087.             
  1088.             if group.parser is not self:
  1089.                 raise ValueError, 'invalid OptionGroup (wrong parser)'
  1090.             
  1091.         else:
  1092.             raise TypeError, 'invalid arguments'
  1093.         self.option_groups.append(group)
  1094.         return group
  1095.  
  1096.     
  1097.     def get_option_group(self, opt_str):
  1098.         if not self._short_opt.get(opt_str):
  1099.             pass
  1100.         option = self._long_opt.get(opt_str)
  1101.         if option and option.container is not self:
  1102.             return option.container
  1103.         
  1104.  
  1105.     
  1106.     def _get_args(self, args):
  1107.         if args is None:
  1108.             return sys.argv[1:]
  1109.         else:
  1110.             return args[:]
  1111.  
  1112.     
  1113.     def parse_args(self, args = None, values = None):
  1114.         """
  1115.         parse_args(args : [string] = sys.argv[1:],
  1116.                    values : Values = None)
  1117.         -> (values : Values, args : [string])
  1118.  
  1119.         Parse the command-line options found in 'args' (default:
  1120.         sys.argv[1:]).  Any errors result in a call to 'error()', which
  1121.         by default prints the usage message to stderr and calls
  1122.         sys.exit() with an error message.  On success returns a pair
  1123.         (values, args) where 'values' is an Values instance (with all
  1124.         your option values) and 'args' is the list of arguments left
  1125.         over after parsing options.
  1126.         """
  1127.         rargs = self._get_args(args)
  1128.         if values is None:
  1129.             values = self.get_default_values()
  1130.         
  1131.         self.rargs = rargs
  1132.         self.largs = largs = []
  1133.         self.values = values
  1134.         
  1135.         try:
  1136.             stop = self._process_args(largs, rargs, values)
  1137.         except (BadOptionError, OptionValueError):
  1138.             err = None
  1139.             self.error(err.msg)
  1140.  
  1141.         args = largs + rargs
  1142.         return self.check_values(values, args)
  1143.  
  1144.     
  1145.     def check_values(self, values, args):
  1146.         '''
  1147.         check_values(values : Values, args : [string])
  1148.         -> (values : Values, args : [string])
  1149.  
  1150.         Check that the supplied option values and leftover arguments are
  1151.         valid.  Returns the option values and leftover arguments
  1152.         (possibly adjusted, possibly completely new -- whatever you
  1153.         like).  Default implementation just returns the passed-in
  1154.         values; subclasses may override as desired.
  1155.         '''
  1156.         return (values, args)
  1157.  
  1158.     
  1159.     def _process_args(self, largs, rargs, values):
  1160.         """_process_args(largs : [string],
  1161.                          rargs : [string],
  1162.                          values : Values)
  1163.  
  1164.         Process command-line arguments and populate 'values', consuming
  1165.         options and arguments from 'rargs'.  If 'allow_interspersed_args' is
  1166.         false, stop at the first non-option argument.  If true, accumulate any
  1167.         interspersed non-option arguments in 'largs'.
  1168.         """
  1169.         while rargs:
  1170.             arg = rargs[0]
  1171.             if arg == '--':
  1172.                 del rargs[0]
  1173.                 return None
  1174.                 continue
  1175.             if arg[0:2] == '--':
  1176.                 self._process_long_opt(rargs, values)
  1177.                 continue
  1178.             if arg[:1] == '-' and len(arg) > 1:
  1179.                 self._process_short_opts(rargs, values)
  1180.                 continue
  1181.             if self.allow_interspersed_args:
  1182.                 largs.append(arg)
  1183.                 del rargs[0]
  1184.                 continue
  1185.             return None
  1186.  
  1187.     
  1188.     def _match_long_opt(self, opt):
  1189.         """_match_long_opt(opt : string) -> string
  1190.  
  1191.         Determine which long option string 'opt' matches, ie. which one
  1192.         it is an unambiguous abbrevation for.  Raises BadOptionError if
  1193.         'opt' doesn't unambiguously match any long option string.
  1194.         """
  1195.         return _match_abbrev(opt, self._long_opt)
  1196.  
  1197.     
  1198.     def _process_long_opt(self, rargs, values):
  1199.         arg = rargs.pop(0)
  1200.         if '=' in arg:
  1201.             (opt, next_arg) = arg.split('=', 1)
  1202.             rargs.insert(0, next_arg)
  1203.             had_explicit_value = True
  1204.         else:
  1205.             opt = arg
  1206.             had_explicit_value = False
  1207.         opt = self._match_long_opt(opt)
  1208.         option = self._long_opt[opt]
  1209.         if option.takes_value():
  1210.             nargs = option.nargs
  1211.             if len(rargs) < nargs:
  1212.                 if nargs == 1:
  1213.                     self.error(_('%s option requires an argument') % opt)
  1214.                 else:
  1215.                     self.error(_('%s option requires %d arguments') % (opt, nargs))
  1216.             elif nargs == 1:
  1217.                 value = rargs.pop(0)
  1218.             else:
  1219.                 value = tuple(rargs[0:nargs])
  1220.                 del rargs[0:nargs]
  1221.         elif had_explicit_value:
  1222.             self.error(_('%s option does not take a value') % opt)
  1223.         else:
  1224.             value = None
  1225.         option.process(opt, value, values, self)
  1226.  
  1227.     
  1228.     def _process_short_opts(self, rargs, values):
  1229.         arg = rargs.pop(0)
  1230.         stop = False
  1231.         i = 1
  1232.         for ch in arg[1:]:
  1233.             opt = '-' + ch
  1234.             option = self._short_opt.get(opt)
  1235.             i += 1
  1236.             if not option:
  1237.                 self.error(_('no such option: %s') % opt)
  1238.             
  1239.             if option.takes_value():
  1240.                 if i < len(arg):
  1241.                     rargs.insert(0, arg[i:])
  1242.                     stop = True
  1243.                 
  1244.                 nargs = option.nargs
  1245.                 if len(rargs) < nargs:
  1246.                     if nargs == 1:
  1247.                         self.error(_('%s option requires an argument') % opt)
  1248.                     else:
  1249.                         self.error(_('%s option requires %d arguments') % (opt, nargs))
  1250.                 elif nargs == 1:
  1251.                     value = rargs.pop(0)
  1252.                 else:
  1253.                     value = tuple(rargs[0:nargs])
  1254.                     del rargs[0:nargs]
  1255.             else:
  1256.                 value = None
  1257.             option.process(opt, value, values, self)
  1258.             if stop:
  1259.                 break
  1260.                 continue
  1261.         
  1262.  
  1263.     
  1264.     def get_prog_name(self):
  1265.         if self.prog is None:
  1266.             return os.path.basename(sys.argv[0])
  1267.         else:
  1268.             return self.prog
  1269.  
  1270.     
  1271.     def expand_prog_name(self, s):
  1272.         return s.replace('%prog', self.get_prog_name())
  1273.  
  1274.     
  1275.     def get_description(self):
  1276.         return self.expand_prog_name(self.description)
  1277.  
  1278.     
  1279.     def exit(self, status = 0, msg = None):
  1280.         if msg:
  1281.             sys.stderr.write(msg)
  1282.         
  1283.         sys.exit(status)
  1284.  
  1285.     
  1286.     def error(self, msg):
  1287.         """error(msg : string)
  1288.  
  1289.         Print a usage message incorporating 'msg' to stderr and exit.
  1290.         If you override this in a subclass, it should not return -- it
  1291.         should either exit or raise an exception.
  1292.         """
  1293.         self.print_usage(sys.stderr)
  1294.         self.exit(2, '%s: error: %s\n' % (self.get_prog_name(), msg))
  1295.  
  1296.     
  1297.     def get_usage(self):
  1298.         if self.usage:
  1299.             return self.formatter.format_usage(self.expand_prog_name(self.usage))
  1300.         else:
  1301.             return ''
  1302.  
  1303.     
  1304.     def print_usage(self, file = None):
  1305.         '''print_usage(file : file = stdout)
  1306.  
  1307.         Print the usage message for the current program (self.usage) to
  1308.         \'file\' (default stdout).  Any occurence of the string "%prog" in
  1309.         self.usage is replaced with the name of the current program
  1310.         (basename of sys.argv[0]).  Does nothing if self.usage is empty
  1311.         or not defined.
  1312.         '''
  1313.         if self.usage:
  1314.             print >>file, self.get_usage()
  1315.         
  1316.  
  1317.     
  1318.     def get_version(self):
  1319.         if self.version:
  1320.             return self.expand_prog_name(self.version)
  1321.         else:
  1322.             return ''
  1323.  
  1324.     
  1325.     def print_version(self, file = None):
  1326.         '''print_version(file : file = stdout)
  1327.  
  1328.         Print the version message for this program (self.version) to
  1329.         \'file\' (default stdout).  As with print_usage(), any occurence
  1330.         of "%prog" in self.version is replaced by the current program\'s
  1331.         name.  Does nothing if self.version is empty or undefined.
  1332.         '''
  1333.         if self.version:
  1334.             print >>file, self.get_version()
  1335.         
  1336.  
  1337.     
  1338.     def format_option_help(self, formatter = None):
  1339.         if formatter is None:
  1340.             formatter = self.formatter
  1341.         
  1342.         formatter.store_option_strings(self)
  1343.         result = []
  1344.         result.append(formatter.format_heading(_('options')))
  1345.         formatter.indent()
  1346.         if self.option_list:
  1347.             result.append(OptionContainer.format_option_help(self, formatter))
  1348.             result.append('\n')
  1349.         
  1350.         for group in self.option_groups:
  1351.             result.append(group.format_help(formatter))
  1352.             result.append('\n')
  1353.         
  1354.         formatter.dedent()
  1355.         return ''.join(result[:-1])
  1356.  
  1357.     
  1358.     def format_help(self, formatter = None):
  1359.         if formatter is None:
  1360.             formatter = self.formatter
  1361.         
  1362.         result = []
  1363.         if self.usage:
  1364.             result.append(self.get_usage() + '\n')
  1365.         
  1366.         if self.description:
  1367.             result.append(self.format_description(formatter) + '\n')
  1368.         
  1369.         result.append(self.format_option_help(formatter))
  1370.         return ''.join(result)
  1371.  
  1372.     
  1373.     def print_help(self, file = None):
  1374.         """print_help(file : file = stdout)
  1375.  
  1376.         Print an extended help message, listing all options and any
  1377.         help text provided with them, to 'file' (default stdout).
  1378.         """
  1379.         if file is None:
  1380.             file = sys.stdout
  1381.         
  1382.         file.write(self.format_help())
  1383.  
  1384.  
  1385.  
  1386. def _match_abbrev(s, wordmap):
  1387.     """_match_abbrev(s : string, wordmap : {string : Option}) -> string
  1388.  
  1389.     Return the string key in 'wordmap' for which 's' is an unambiguous
  1390.     abbreviation.  If 's' is found to be ambiguous or doesn't match any of
  1391.     'words', raise BadOptionError.
  1392.     """
  1393.     if wordmap.has_key(s):
  1394.         return s
  1395.     else:
  1396.         possibilities = _[1]
  1397.         if len(possibilities) == 1:
  1398.             return possibilities[0]
  1399.         elif not possibilities:
  1400.             raise BadOptionError(_('no such option: %s') % s)
  1401.         else:
  1402.             raise BadOptionError(_('ambiguous option: %s (%s?)') % (s, ', '.join(possibilities)))
  1403.  
  1404. make_option = Option
  1405.